GET Results Status
Returns the status of the result that is associated with a LetsGetChecked test kit. The following result statuses are possible:
| Status | Description |
|---|---|
| Activation completed | The participant successfully activated their test kit. |
| Cancelled | A Cancelled status might occur if a patient requests that a lab should not process their test sample. If a result is cancelled, the client cannot fetch a Results payload. |
| SampleCollected | The timestamp when the carrier collected the test kit from the participant. |
| SampleAtLab | The participant's sample is received at the LetsGetChecked lab. |
| ResultsReceived | The results are reported by the LetsGetChecked Lab and are awaiting physician approval before they are released. |
| ResultsAvailable | The results are available for a test kit. The LetsGetChecked Medical team reviews the test results before they are communicated to the participant. |
Request
Endpoint
GET {clientId}/api/v1/results/{barcode}?alphaCode={alphaCode}&fields=status
Path parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| clientId | The clientId is a unique code that is provided by LetsGetChecked. The code is formed by 1 to 4 alphanumeric characters. | string | Required |
| Barcode | Formatted as LGC-0000-0000-0000, where 0 indicates any digit. | string | Required |
| AlphaCode | Formatted as AAAAAA, where A indicates any uppercase letter from A to Z. | string | Optional |
| Fields | Determines which fields to include in the response. The default value is status. Tip: This parameter is included to enable more details to be added in the future. | string | Optional |
Response
The sample response is a single JSON object that contains the following fields:
| Property | Description | Type |
|---|---|---|
| status | The result status | string |
Sample response
{
"status" : "string"
}
